Apple WWDC 1996

home *** CD-ROM | disk | FTP | other *** search

/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / IDLIncludes / OCETemplates.idl < prev next >

Wrap

Text File | 1996-05-01 | 16.4 KB | 382 lines | [TEXT/MPS ]

/* File: OCETemplates.idl Contains: Apple Open Collaboration Environment Templates Interfaces. Version: Technology: AOCE Toolbox 1.02 Release: Universal Interfaces 3.0d3 on Copland DR1 Copyright: © 1984-1996 by Apple Computer, Inc. All rights reserved. Bugs?: If you find a problem with this file, send the file and version information (from above) and the problem description to: Internet: apple.bugs@applelink.apple.com AppleLink: APPLE.BUGS */ #ifndef __OCETEMPLATES_IDL__ #define __OCETEMPLATES_IDL__ #include <somobj.idl> #include <somcls.idl> #ifndef __TYPES_IDL__ #include <Types.idl> #endif #ifndef __EVENTS_IDL__ #include <Events.idl> #endif #ifndef __OCE_IDL__ #include <OCE.idl> #endif #ifndef __OCESTANDARDMAIL_IDL__ #include <OCEStandardMail.idl> #endif #ifdef __SOMIDL__ #if FOR_SYSTEM7_ONLY /***********************************************************************************/ /********************************* Code Resources: *********************************/ /***********************************************************************************/ /* Target specification: */ typedef long DETTargetSelector; typedef SOMLargeStruct DETTargetSpecification; /* Derived from a struct of 16 bytes in size */ /* Code resource calls and call-backs both return an OSType: kDETDidNotHandle (1) = used by template to say "I didn't handle it" (for calls only) noErr = function completed successfully any error = function failed, and here's why */ /* Call-back functions: reqFunction Action ----------- ------ kDETcmdBeep Call SysBeep; useful for testing that a code resource's calls/call-backs are working at all kDETcmdBusy Put up watch cursor and switch processes; user events elicit a beep kDETcmdChangeCallFors Change call-fors mask kDETcmdGetCommandSelectionCount Get the command selection count (for calls which have a command selection list) kDETcmdGetCommandItemN Get command selection item n (for calls which have a command selection list) kDETcmdOpenDSSpec PackedDSSpec open (can also be done via AppleEvents -- this is a short-cut) kDETcmdAboutToTalk About to talk to user: bring us to front, disable watch cursor, etc. kDETcmdUnloadTemplates Flush templates kDETcmdTemplateCounts Return number of aspect and info-page templates in system kDETcmdGetDSSpec Get the PackedDSSpec for this object kDETcmdSublistCount Return the count of the sublist items kDETcmdSelectedSublistCount Return the count of the selected sublist items kDETcmdRequestSync Request a sync-up of the aspect with the catalog kDETcmdBreakAttribute Break an attribute -- apply all applicable patterns to an attribute to generate properties kDETcmdGetTemplateFSSpec Get the FSSpec of the file containing the template kDETcmdGetOpenEdit Return the property of the view being edited (or kDETNoProperty if none) kDETcmdCloseEdit Close the current edit kDETcmdGetPropertyType Get a property type kDETcmdGetPropertyNumber Get a property, number format kDETcmdGetPropertyRString Get a property, RString format kDETcmdGetPropertyBinarySize Get a property, binary, return size kDETcmdGetPropertyBinary Get a property, binary format kDETcmdGetPropertyChanged Get a property changed flag kDETcmdGetPropertyEditable Get a property editable flag kDETcmdSetPropertyType Set a property type kDETcmdSetPropertyNumber Set a property, number format kDETcmdSetPropertyRString Set a property, RString format kDETcmdSetPropertyBinary Set a property, binary data & size kDETcmdSetPropertyChanged Set a property changed flag kDETcmdSetPropertyEditable Set a property editable flag kDETcmdDirtyProperty Dirty a property (notify other code resources of change) kDETcmdDoPropertyCommand Issue a property command kDETcmdAddMenu Add to the end of a dynamic menu kDETcmdRemoveMenu Remove a dynamic menu item kDETcmdMenuItemRString Get a dynamic menu item RString kDETcmdSaveProperty Force a save of a property -- apply all applicable patterns to write out the property kDETcmdGetCustomViewUserReference Get custom view user reference (as given in .r file) kDETcmdGetCustomViewBounds Get custom view current bounds kDETcmdGetResource Get a resource from a template */ typedef unsigned long DETCallBackFunctions; /* Call functions: reqFunction Action ----------- ------ kDETcmdInit Called once when template is first loaded (good time to allocate private data); returns call-for list kDETcmdExit Called once when template is freed (good time to free private data) kDETcmdAttributeCreation New sublist attribute creation about to occur; this gives the template a chance to modify the value that's about to be created; sent to the template that will be used for the main aspect of the new entry kDETcmdDynamicForwarders Return a list of dynamically created forwarders kDETcmdInstanceInit Called once when instance of template is started (good time to allocate private instance data) kDETcmdInstanceExit Called once when instance is ended (good time to free private instance data) kDETcmdIdle Called periodically during idle times kDETcmdViewListChanged Called when the info-page view-list (list of enabled views) has changed kDETcmdValidateSave Validate save: about to save info-page, return noErr (or kDETDidNotHandle) if it's OK to do so kDETcmdDropQuery Drop query: return the appropriate operation for this drag; ask destination kDETcmdDropMeQuery Drop query: return the appropriate operation for this drag; ask dropee kDETcmdAttributeNew Attribute value new (return kDETDidNotHandle to let normal new processing occur) kDETcmdAttributeChange Attribute value change (return kDETDidNotHandle to let normal change processing occur) kDETcmdAttributeDelete Attribute value delete (return kDETDidNotHandle to let normal deletion occur); sent to the main aspect of the attribute that's about to be deleted kDETcmdItemNew Target item (record or attribute) has just been created kDETcmdOpenSelf Self open (return noErr to prevent opening; return kDETDidNotHandle to allow it) kDETcmdDynamicResource Return a dynamically created resource kDETcmdShouldSync Check if the code resource wants to force a sync (update data from catalog) kDETcmdDoSync Give code resource a chance to sync (read in and break all attributes) kDETcmdPropertyCommand Command received in the property number range (usually means a button's been pushed) kDETcmdMaximumTextLength Return maximum size for text form of property kDETcmdPropertyDirtied Property dirtied, need to redraw kDETcmdPatternIn Custom pattern element encountered on reading in an attribute kDETcmdPatternOut Custom pattern element encountered on writing out an attribute kDETcmdConvertToNumber Convert from template-defined property type to number kDETcmdConvertToRString Convert from template-defined property type to RString kDETcmdConvertFromNumber Convert from number to template-defined property type kDETcmdConvertFromRString Convert from RString to template-defined property type kDETcmdCustomViewDraw Custom view draw kDETcmdCustomViewMouseDown Custom view mouse down kDETcmdKeyPress Key press (used primarily to filter entry into EditText views) kDETcmdPaste Paste (used primarily to filter entry into EditText views) kDETcmdCustomMenuSelected Custom Catalogs menu selected kDETcmdCustomMenuEnabled Return whether custom Catalogs menu entry should be enabled */ typedef unsigned long DETCallFunctions; /* Valid commandIDs for DETDropQueryBlock and DETDropMeQueryBlock (in addition to property numbers): */ typedef SOMLargeStruct DETProtoCallBackBlock; /* Derived from a struct of 22 bytes in size */ typedef SOMFourByteStruct DETBeepBlock; /* Derived from a struct of 4 bytes in size */ typedef SOMFourByteStruct DETBusyBlock; /* Derived from a struct of 4 bytes in size */ typedef SOMLargeStruct DETChangeCallForsBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETGetCommandSelectionCountBlock; /* Derived from a struct of 8 bytes in size */ typedef unsigned long DETItemType; /* FSSpec plus possibly interesting additional info */ typedef SOMLargeStruct DETFSInfo; /* Derived from a struct of 80 bytes in size */ typedef SOMLargeStruct DSRec; /* Derived from a struct of 10 bytes in size */ typedef SOMLargeStruct ItemRec; /* Derived from a struct of 22 bytes in size */ typedef SOMLargeStruct DETGetCommandItemNBlock; /* Derived from a struct of 22 bytes in size */ typedef SOMLargeStruct DETGetDSSpecBlock; /* Derived from a struct of 32 bytes in size */ typedef SOMLargeStruct DETGetTemplateFSSpecBlock; /* Derived from a struct of 96 bytes in size */ typedef SOMLargeStruct DETGetOpenEditBlock; /* Derived from a struct of 22 bytes in size */ typedef SOMLargeStruct DETCloseEditBlock; /* Derived from a struct of 20 bytes in size */ typedef SOMLargeStruct DETGetPropertyTypeBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETGetPropertyNumberBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETGetPropertyRStringBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETGetPropertyBinarySizeBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETGetPropertyBinaryBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETGetPropertyChangedBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETGetPropertyEditableBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETSetPropertyTypeBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETSetPropertyNumberBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETSetPropertyRStringBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETSetPropertyBinaryBlock; /* Derived from a struct of 30 bytes in size */ typedef SOMLargeStruct DETSetPropertyChangedBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETSetPropertyEditableBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETDirtyPropertyBlock; /* Derived from a struct of 22 bytes in size */ typedef SOMLargeStruct DETDoPropertyCommandBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETSublistCountBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETSelectedSublistCountBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETRequestSyncBlock; /* Derived from a struct of 20 bytes in size */ typedef SOMLargeStruct DETAddMenuBlock; /* Derived from a struct of 34 bytes in size */ typedef SOMLargeStruct DETRemoveMenuBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETMenuItemRStringBlock; /* Derived from a struct of 30 bytes in size */ typedef SOMLargeStruct DETOpenDSSpecBlock; /* Derived from a struct of 8 bytes in size */ typedef SOMFourByteStruct DETAboutToTalkBlock; /* Derived from a struct of 4 bytes in size */ typedef SOMLargeStruct DETBreakAttributeBlock; /* Derived from a struct of 26 bytes in size */ typedef SOMLargeStruct DETSavePropertyBlock; /* Derived from a struct of 22 bytes in size */ typedef SOMLargeStruct DETGetCustomViewUserReferenceBlock; /* Derived from a struct of 24 bytes in size */ typedef SOMLargeStruct DETGetCustomViewBoundsBlock; /* Derived from a struct of 30 bytes in size */ typedef SOMLargeStruct DETGetResourceBlock; /* Derived from a struct of 30 bytes in size */ typedef SOMLargeStruct DETTemplateCounts; /* Derived from a struct of 12 bytes in size */ typedef SOMFourByteStruct DETUnloadTemplatesBlock; /* Derived from a struct of 4 bytes in size */ typedef SOMLargeStruct DETCallBackBlock; /* Derived from a struct of 950 bytes in size */ typedef OpaquePtr DETCallBackBlockPtr; /* Substituted OpaquePtr for “DETCallBackBlock*” */ typedef OpaquePtr DETCallBlockPtr; /* Substituted OpaquePtr for “DETCallBlock*” */ typedef OpaquePtr DETCallBackProcPtr; typedef OpaquePtr DETCallBackUPP; typedef DETCallBackUPP DETCallBack; typedef SOMLargeStruct DETProtoCallBlock; /* Derived from a struct of 40 bytes in size */ typedef SOMLargeStruct DETInitBlock; /* Derived from a struct of 20 bytes in size */ typedef SOMLargeStruct DETExitBlock; /* Derived from a struct of 16 bytes in size */ typedef SOMLargeStruct DETInstanceInitBlock; /* Derived from a struct of 38 bytes in size */ typedef SOMLargeStruct DETInstanceExitBlock; /* Derived from a struct of 38 bytes in size */ typedef SOMLargeStruct DETInstanceIdleBlock; /* Derived from a struct of 38 bytes in size */ typedef SOMLargeStruct DETPropertyCommandBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETMaximumTextLengthBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETViewListChangedBlock; /* Derived from a struct of 38 bytes in size */ typedef SOMLargeStruct DETPropertyDirtiedBlock; /* Derived from a struct of 40 bytes in size */ typedef SOMLargeStruct DETValidateSaveBlock; /* Derived from a struct of 42 bytes in size */ typedef SOMLargeStruct DETDropQueryBlock; /* Derived from a struct of 82 bytes in size */ typedef SOMLargeStruct DETDropMeQueryBlock; /* Derived from a struct of 82 bytes in size */ typedef SOMLargeStruct DETAttributeCreationBlock; /* Derived from a struct of 70 bytes in size */ typedef SOMLargeStruct DETAttributeNewBlock; /* Derived from a struct of 92 bytes in size */ typedef SOMLargeStruct DETAttributeChangeBlock; /* Derived from a struct of 100 bytes in size */ typedef SOMLargeStruct DETAttributeDeleteBlock; /* Derived from a struct of 48 bytes in size */ typedef SOMLargeStruct DETItemNewBlock; /* Derived from a struct of 38 bytes in size */ typedef SOMLargeStruct DETShouldSyncBlock; /* Derived from a struct of 40 bytes in size */ typedef SOMLargeStruct DETDoSyncBlock; /* Derived from a struct of 38 bytes in size */ typedef SOMLargeStruct DETPatternInBlock; /* Derived from a struct of 58 bytes in size */ typedef SOMLargeStruct DETPatternOutBlock; /* Derived from a struct of 62 bytes in size */ typedef SOMLargeStruct DETOpenSelfBlock; /* Derived from a struct of 40 bytes in size */ typedef SOMLargeStruct DETConvertToNumberBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETConvertToRStringBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETConvertFromNumberBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETConvertFromRStringBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETCustomViewDrawBlock; /* Derived from a struct of 40 bytes in size */ typedef SOMLargeStruct DETCustomViewMouseDownBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETKeyPressBlock; /* Derived from a struct of 44 bytes in size */ typedef SOMLargeStruct DETPasteBlock; /* Derived from a struct of 42 bytes in size */ typedef SOMLargeStruct DETCustomMenuSelectedBlock; /* Derived from a struct of 40 bytes in size */ typedef SOMLargeStruct DETCustomMenuEnabledBlock; /* Derived from a struct of 42 bytes in size */ typedef SOMLargeStruct DETForwarderListItem; /* Derived from a struct of 1032 bytes in size */ typedef OpaquePtr DETForwarderListPtr; /* Substituted OpaquePtr for “DETForwarderListItem*” */ typedef OpaquePtr DETForwarderListHandle; /* Substituted OpaquePtr for “DETForwarderListPtr*” */ typedef SOMLargeStruct DETDynamicForwardersBlock; /* Derived from a struct of 20 bytes in size */ typedef SOMLargeStruct DETDynamicResourceBlock; /* Derived from a struct of 50 bytes in size */ typedef SOMLargeStruct DETCallBlock; /* Derived from a struct of 1646 bytes in size */ /* Call-for list: */ typedef OpaquePtr DETCallProcPtr; typedef OpaquePtr DETCallUPP; typedef DETCallUPP DETCall; /* This following macro saves you from having to dig out the call-back pointer from the call block: */ #endif #endif /* __SOMIDL__ */ #endif /* __OCETEMPLATES_IDL__ */